package cn.tedu.day01;

import java.io.File;
import java.io.IOException;

/**
 * Date：2021年10月
 * Author：程Sir
 * Content:
 *  这是演示文档注释规范的类
 * @author 这是作者标识
 * @since 1.5.1 标识当前类是从1.5.1版本开始使用的
 * @see String 标识当前类的使用是参见了这1个类
 *
 * 生成doc文档时填写的内容：
 *
 *  local： zh_CN
 *  param：-encoding UTF-8 -charset UTF-8 -windowtitle "这是文档的主题"
 *
 */
public class APIDemo {
    /**
     * @deprecated 1.5.0 这是一个过时方法，表示使用的时候要注意，可能存在效率、安全问题
     */
    public void method1(){

    }

    /**
     * 这是当前类的名字属性
     */
    public String name;

    /**
     * 这是一个设置名字的方法
     * @param name 传入的要设置的名字
     */
    public void setName(String name){
        this.name = name;
    }

    /**
     * 这是一个获取名字的方法
     * @return 将当前类设置的名字返回给调用者
     */
    public String getName(){
        return this.name;
    }

    /**
     * 这是一个读取文件的方法
     * @param file 传入要读取的文件
     * @throws IOException 抛出IO异常
     * @return 返回读到的内容
     */
    public String read(File file) throws IOException {

        new File("123.txt");
        return "";
    }

}
